-
Notifications
You must be signed in to change notification settings - Fork 435
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(devcontainer): devcontainer setup #1086
Conversation
Signed-off-by: Azanul <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition :)
// For format details, see https://aka.ms/devcontainer.json. For config options, see the | ||
// README at: https://github.com/devcontainers/templates/tree/main/src/go | ||
{ | ||
"name": "Go", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should name it something general
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to suggest names
}, | ||
"customizations": { | ||
"vscode": { | ||
"extensions": [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about those who use a non-vscode env ;) Like me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This config works with GH Codespaces and VSCode with devcontainers extension. If you use something that has devcontainer support then it'll probably have it's own customizations. Jetbrains has a guide to it.
If you doubt that vscode extensions part might interfere with the spawning devcontainer, I don't think it will but you're welcome to test it out.
What do you use?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point from @AvineshTripathi. I'm on SublimeText and nvim.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know that neovim has devcontainer support, don't know if SublimeText does or not.
As I said, the respective tools will have their own customizations. I know how to mention the same for vscode & codespaces but not for other tools.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll merge this PR, but we can open additional PRs to extend it to other IDEs.
Problem
Some new contributors face issues when setting up their environment for the first time
Solution
Adds a devcontainer config file. This can be used to spawn a devcontainer locally or a GitHub codespace with
How to Test
Try to create a devcontainer using VS code extension or try creating a GitHub codespace.
Checklist